customfilter: Convert docs
authorMatthias Clasen <mclasen@redhat.com>
Sun, 28 Feb 2021 18:00:55 +0000 (13:00 -0500)
committerEmmanuele Bassi <ebassi@gnome.org>
Thu, 11 Mar 2021 16:37:35 +0000 (16:37 +0000)
gtk/gtkcustomfilter.c
gtk/gtkcustomfilter.h

index 34f7dfb1cd9d1b57908d7bb43a00952724f10d20..97c86e2470933c9a3d4d303d17b09cdfe6fd402a 100644 (file)
 #include "gtktypebuiltins.h"
 
 /**
- * SECTION:gtkcustomfilter
- * @Title: GtkCustomFilter
- * @Short_description: Filtering with callbacks
+ * GtkCustomFilter:
  *
- * #GtkCustomFilter is a #GtkFilter that uses a callback to determine
- * whether to include an item or not.
+ * `GtkCustomFilter` determines whether to include items with a callback.
  */
 struct _GtkCustomFilter
 {
@@ -108,7 +105,7 @@ gtk_custom_filter_init (GtkCustomFilter *self)
  * If the filter func changes its filtering behavior,
  * gtk_filter_changed() needs to be called.
  *
- * Returns: a new #GtkCustomFilter
+ * Returns: a new `GtkCustomFilter`
  **/
 GtkCustomFilter *
 gtk_custom_filter_new (GtkCustomFilterFunc match_func,
@@ -126,12 +123,12 @@ gtk_custom_filter_new (GtkCustomFilterFunc match_func,
 
 /**
  * gtk_custom_filter_set_filter_func:
- * @self: a #GtkCustomFilter
+ * @self: a `GtkCustomFilter`
  * @match_func: (nullable): function to filter items
  * @user_data: (nullable): user data to pass to @match_func
  * @user_destroy: destroy notify for @user_data
  *
- * Sets (or unsets) the function used for filtering items.
+ * Sets the function used for filtering items.
  *
  * If @match_func is %NULL, the filter matches all items.
  *
@@ -140,7 +137,7 @@ gtk_custom_filter_new (GtkCustomFilterFunc match_func,
  *
  * If a previous function was set, its @user_destroy will be
  * called now.
- **/
+ */
 void
 gtk_custom_filter_set_filter_func (GtkCustomFilter     *self,
                                    GtkCustomFilterFunc  match_func,
index 784e4fdca94db2af9121202c012752b60839a003..ba2fae055e88a03d6bca79a0e584cc8a4dd6f632 100644 (file)
@@ -34,6 +34,7 @@ G_BEGIN_DECLS
  * @user_data: user data
  *
  * User function that is called to determine if the @item should be matched.
+ *
  * If the filter matches the item, this function must return %TRUE. If the
  * item should be filtered out, %FALSE must be returned.
  *